From: Thiemo Mättig <thiemo.maettig@wikimedia.de>
Date: Thu, 26 Mar 2015 15:42:14 +0000 (+0100)
Subject: Fix inline documentation in WebResponse
X-Git-Tag: 1.31.0-rc.0~11983
X-Git-Url: http://git.cyclocoop.org/%7D%7Cconcat%7B?a=commitdiff_plain;h=63a8237c641d8517cc27caf66d7b8ced53d1d37d;p=lhc%2Fweb%2Fwiklou.git

Fix inline documentation in WebResponse

Main reason to touch this file are the missing "null" types in the
documentation.

Change-Id: Ifab16c276efb3d8c4aa0a27d8d5106d4e3303794
---

diff --git a/includes/WebResponse.php b/includes/WebResponse.php
index f977c205aa..83ac51a341 100644
--- a/includes/WebResponse.php
+++ b/includes/WebResponse.php
@@ -55,12 +55,12 @@ class WebResponse {
 
 	/**
 	 * Set the browser cookie
-	 * @param string $name Name of cookie
-	 * @param string $value Value to give cookie
+	 * @param string $name The name of the cookie.
+	 * @param string $value The value to be stored in the cookie.
 	 * @param int|null $expire Unix timestamp (in seconds) when the cookie should expire.
 	 *        0 (the default) causes it to expire $wgCookieExpiration seconds from now.
 	 *        null causes it to be a session cookie.
-	 * @param array $options Assoc of additional cookie options:
+	 * @param array|null $options Assoc of additional cookie options:
 	 *     prefix: string, name prefix ($wgCookiePrefix)
 	 *     domain: string, cookie domain ($wgCookieDomain)
 	 *     path: string, cookie path ($wgCookiePath)
@@ -164,7 +164,7 @@ class FauxResponse extends WebResponse {
 
 	/**
 	 * @param string $key The name of the header to get (case insensitive).
-	 * @return string
+	 * @return string|null The header value (if set); null otherwise.
 	 */
 	public function getHeader( $key ) {
 		$key = strtoupper( $key );
@@ -185,12 +185,10 @@ class FauxResponse extends WebResponse {
 	}
 
 	/**
-	 * @todo document. It just ignore optional parameters.
-	 *
-	 * @param string $name Name of cookie
-	 * @param string $value Value to give cookie
-	 * @param int $expire Number of seconds til cookie expires (Default: 0)
-	 * @param array $options Ignored
+	 * @param string $name The name of the cookie.
+	 * @param string $value The value to be stored in the cookie.
+	 * @param int|null $expire Ignored in this faux subclass.
+	 * @param array|null $options Ignored in this faux subclass.
 	 */
 	public function setcookie( $name, $value, $expire = 0, $options = null ) {
 		$this->cookies[$name] = $value;
@@ -198,7 +196,7 @@ class FauxResponse extends WebResponse {
 
 	/**
 	 * @param string $name
-	 * @return string
+	 * @return string|null
 	 */
 	public function getcookie( $name ) {
 		if ( isset( $this->cookies[$name] ) ) {